home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1995 #2 / Amiga Plus CD - 1995 - No. 2.iso / pd / mui / clchat / clchatserver.doc next >
Text File  |  1995-04-11  |  10KB  |  271 lines
  1. CLChatSystem 3.3 for AmiTCP
  2. ---------------------------
  3.  
  4. (1) Copyrights
  5.  
  6.     The CLChatServer, the CLChatD, CLChatLink and the CLChatGUI are
  7.     Copyright (C) 1994-1995 Oliver Wagner (o.wagner@pluribus.wupper.de)
  8.     All Rights Reserved.
  9.  
  10.     The files are freely distributable as long as no modifications are
  11.     made to any part of the package and all files are distributed in
  12.     a single archive, accompanied by this documentation file.
  13.  
  14.     CLChatGUI is a MUI application. MUI is (C) 1993-1995 Stefan Stuntz.
  15.  
  16.     AmiTCP is (C) 1994-95 NSDI Inc.
  17.  
  18.  
  19. (2) Overview
  20.  
  21.     This is a multi-user multi-channel chat system somewhat based on
  22.     IRC. It features:
  23.  
  24.     o unlimited number of users
  25.     o unlimited number of channels
  26.     o private messaging
  27.     o automatic user identification
  28.     o flood protection
  29.     o NEW: user banning
  30.     o NEW: multiple server capability with loop protection
  31.     o channel operator privileges for setting channel topics
  32.       and removing users from a channel
  33.     o chat operator privilege for global channel operator status
  34.       and removing users from chat completely
  35.  
  36.     The user frontend for the chat is a comfortable GUI client
  37.     providing
  38.  
  39.     o easy user & channel operations
  40.     o input history
  41.     o automatic notifications of certain events via Deiconification
  42.       or beep
  43.     o builtin ARexx-Port
  44.     o NEW: direct file transfers to remote users via IP
  45.  
  46.  
  47. (3) Origin
  48.  
  49.     The Chatsystem is originally part of the Connectline/Amiga BBS
  50.     package which features an ANSI text client for online usage
  51.     and the possibility to login to the chat during Hydra file 
  52.     transfers. The standlone ChatServer and the GUI client are
  53.     only a subset of the whole package.
  54.  
  55.     Write to Connectline@pluribus.wupper.de for more information
  56.     about Connectline.
  57.  
  58.  
  59. (4) Server Installation
  60.  
  61.     Copy the CLChatServer to AmiTCP:bin
  62.     Copy the CLChatLink to AmiTCP:bin
  63.     Copy the CLChatD to AmiTCP:serv
  64.  
  65.     Add the following line to AmiTCP:db/services:
  66.     clchat/5555
  67.  
  68.     Add the following line to AmiTCP:db/InetD.conf:
  69.     clchat    stream      tcp nowait root amitcp:serv/clchatd
  70.  
  71.     Add the following line to AmiTCP:bin/startnet:
  72.     run >NIL: AmiTCP:bin/CLChatServer
  73.  
  74.     Optionally create a file named AmiTCP:db/ChatServer.MOTD
  75.     containing a text file which will be display to each new user
  76.     logging into the chat.
  77.  
  78.     Optionally create a file named AmiTCP:db/ChatServer.OPList
  79.     containing a list of users which have the "Chat Operator"
  80.     privilege. These users automatically receive channel operator
  81.     status for every channel they join and can use the hidden
  82.     server command "/KILL" to remove other users from the
  83.     chat server. They may also the "/NETINFO" command to inquiry
  84.     chat network information, and use the BAN commands to list,
  85.     add or remove user bans.
  86.     This file contains entries of the following form:
  87.     Nickname Netaddress
  88.     For example:
  89.     Olli olli@lsd.wupper.de
  90.  
  91.     Optionally create a file named AmiTCP:db/ChatServer.Servers
  92.     containing a list of remote servers allowed to connect to your
  93.     server. This file contains a list of FQDN addresses or a
  94.     standard AmigaDOS wildcard matching FQDN addresses. If this
  95.     file is missing, all servers are allowed to connect.
  96.     If you want to ban a single server only, you can add a
  97.     exclusive pattern. For example, to ban server "lsd.wupper.de"
  98.     only, add the line
  99.     ~(lsd.wupper.de)
  100.     The first line of the file may contain a number specifying
  101.     the maximum number of servers to connect. This defaults to 8.
  102.  
  103.     You can make CLChatD and CLChatLink resident to increase
  104.     startup speed and reduce memory usage; this might proof
  105.     useful if you run or accept several connections.
  106.  
  107.  
  108. (5) Client installation
  109.  
  110.     No installation required, simply run the Client from either
  111.     Shell or Workbench. It will prompt for your user information
  112.     and the server to connect to. See the Client guide for
  113.     more information about using it.
  114.  
  115.  
  116. (6) Using the server
  117.  
  118.     Using the server should be quite self-explainatory. Use the
  119.     command "/?" to obtain a list of available commands.
  120.  
  121.     Channels are created automatically when a users joins
  122.     and removed when the last user leaves. There is a
  123.     persistant default channel called MAIN on which every
  124.     new users starts. The first user entering a channel
  125.     will obtain channel operator status. He may change
  126.     the topic, kick other users, give or remove channel
  127.     operator status from them.
  128.  
  129.     Specifc users may be banned from a server using the
  130.     /BANADD command which is available to chat operators only.
  131.     Bans are stored in the file "AmiTCP:DB/ChatServer.UserBans"
  132.     and contain FQDN addresses or a AmigaDOS wildcard matching
  133.     FQDN addresses. You may want to use wildcards of the form
  134.     "#?@machine" because the user part of addresses is generally
  135.     the same as the nickname which may be set by the user.
  136.     For example, to ban users from lsd.wupper.de, use the
  137.     entry
  138.     #?@lsd.wupper.de
  139.  
  140.     Note that adding a line "#?" will make you quite lonely
  141.     on your server.
  142.  
  143.     The server respons to three shell signals. CTRL^C will
  144.     cause it to terminate instantly, CTRL^E will cause a
  145.     restart (with reloading the executable) and CTRL^F will
  146.     cause the server to output diagnostic stats into the
  147.     shell window.
  148.  
  149.  
  150. (7) Connecting several servers
  151.  
  152.     After running your local server, use the command "CLChatLink"
  153.     to connect to a different server. Usage is
  154.     CLChatLink <remoteservername> <remoteport> [retrycount]
  155.  
  156.     The retrycount is optional; if specified, CLChatLink will
  157.     retry a connection until the count runs out. If a already
  158.     successfully established connection break, retries start
  159.     back from 1.
  160.  
  161.     Note that the server-server protocol is quite bandwidth
  162.     expensive, so you should *NOT* create a server for single
  163.     users only.
  164.  
  165.     Note that nicknames must be unique on all servers; if servers
  166.     connect and a nick collision occurs, both users are removed
  167.     from their correspondending servers and a nick collision
  168.     message is broadcasted.
  169.  
  170.     Server loops may be created; every server message carries
  171.     a unique messageid which will be checked by every server
  172.     it passes; dupes are filtered out. Server loops may raise
  173.     broadcast speed esspecially on slow network connections.
  174.     The server uses some kind of smart routing for private
  175.     messages: if the destination of a private message is on a
  176.     directly linked server, the message is send to this
  177.     server only. If not, it is broadcasted, so no routing
  178.     tables are necessary.
  179.  
  180.  
  181. (8) History:
  182.  
  183.     See the CLChatGUI.(doc|guide) for more specific GUI
  184.     client revision information.
  185.  
  186.     Release 3.0
  187.     -----------
  188.     - the server now uses smart routing for private messages;
  189.       if the destination server is a direct link, no broadcast
  190.       is produced
  191.     - added user banning capabilities
  192.     - added /NETINFO server inquiry broadcast
  193.     - added chat operator command output on /HELP if the
  194.       use is a chat operator.
  195.     - made /SERVERS command available to normal chat users
  196.     - updated CLChatLink to correctly fill in the remote
  197.       server name.
  198.     - extended server msgs with a message id tag to filter
  199.       message dupes produced by server loops.
  200.  
  201.     Release 3.1
  202.     -----------
  203.     - everything is now compiled with SAS/C 6.55. Also added
  204.       server version directly compiled for 68030 CPUs.
  205.     - added more detailed NETINFO output.
  206.     - added /STAT command for chat operators. Also "/STAT *"
  207.       broadcasts /STAT requests via net.
  208.     - extended /USERS command with "S" option to display
  209.       users with the servers they're on.
  210.     - added /RESTART command for chat operators to have
  211.       the server restart itself. Also CTRL^E will cause
  212.       a restart.
  213.     - added CTRL^F response displaying server stats to
  214.       the shell.
  215.     - fixed CLChatLink and CLChatD to fill in the IP
  216.       address of remote servers for the /SERVERS command
  217.       output.
  218.     - fixed smart privmsg routing.
  219.     - fixed user removement for flood protection and
  220.       /KILL commands.
  221.     - fixed may GUI client bugs & quirks.
  222.     - GUI client now has IP file transfer option similar
  223.       to DCC
  224.     - GUI client now has a PING option to test links
  225.       from user to user directly
  226.     - fixed bug in the server which caused a stack
  227.       overwrite on privmsgs > 230 bytes
  228.     - both CLChatD and CLChatLink are now "pure" code
  229.       and can be made resident for more efficient memory
  230.       usage
  231.  
  232.     Release 3.2
  233.     -----------
  234.     - fixed local /STAT output to report only local
  235.       users
  236.     - fixed server validation bug; checked IP addresse instead
  237.       of FQDN
  238.     - fixed server reject error message
  239.     - cleaned up GUI client scroller handling
  240.     - added PLUBOT sample code
  241.  
  242.  
  243.     Release 3.3
  244.     -----------
  245.     - CLChatLink was seriously broken; retry didn't worked
  246.       and broken active links causes server crashes due to
  247.       illegal messages.
  248.     - increased stacksizes or reduced stack usage in all parts
  249.       of the package due to frequent crashes on some setups.
  250.     - some GUI client cleanup.
  251.  
  252.  
  253. (9) ARCnet
  254.  
  255.     There is already a public Internet chat network based on
  256.     CLChat called the "ARCnet" (Amiga Relay Chat Network).
  257.     See the client documentation for up-to-date information
  258.     about this network and servers you can connect to.
  259.  
  260.  
  261. (10) Thanks must go to:
  262.  
  263.      Roy Millican  - for encouragement and running the first
  264.                      public CLChat server on the InterNet ;-)
  265.  
  266.      James Atwill, `Mephisto'
  267.                    - for their help during multi server testing
  268.  
  269.      Jeremiah S. Junken
  270.                    - for the CLChatGUI icon
  271.